Add new vignette for tips and tricks - #311
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a new vignette that collects various tips and tricks for using the osmextract package.
- Introduces
vignettes/tips-and-tricks.Rmdwith setup and cleanup code chunks - Provides an example of selecting OSM objects by their IDs
- Manages download directory and restores user settings after execution
Comments suppressed due to low confidence (2)
vignettes/tips-and-tricks.Rmd:19
- [nitpick] The variable name 'user_par' is ambiguous; consider renaming to 'original_pars' or 'user_parameters' for better clarity.
user_par = par(no.readonly = TRUE)
vignettes/tips-and-tricks.Rmd:22
- [nitpick] The variable name 'old_dd' is unclear; consider renaming to 'original_download_dir' to improve readability.
old_dd = Sys.getenv("OSMEXT_DOWNLOAD_DIRECTORY", tempdir())
Robinlovelace
approved these changes
Jul 14, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I believe this new vignette might be a nice place to collect all examples and use cases which do not deserve an ad-hoc page in the docs but are still worth of presentation.
See also #249.